docs: improve eventing image and wording#3303
Merged
csviri merged 2 commits intooperator-framework:mainfrom Apr 22, 2026
Merged
docs: improve eventing image and wording#3303csviri merged 2 commits intooperator-framework:mainfrom
csviri merged 2 commits intooperator-framework:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation to reduce confusion around “dependent resources” terminology in the eventing docs, and refreshes the event-sources architecture illustration.
Changes:
- Reworded eventing documentation from “dependent resources” to “managed resources” in key places.
- Replaced the event-sources PNG diagram reference with an inline Mermaid diagram.
- Simplified the
DeploymentReconcilerexample infeatures.mdby removingTestExecutionInfoProviderfrom theimplementslist.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/content/en/docs/documentation/eventing.md | Terminology tweaks and diagram change (PNG → Mermaid) in the eventing documentation. |
| docs/content/en/docs/documentation/features.md | Updates a Java example signature in the features documentation. |
| docs/static/images/event-sources.png | Updated static diagram asset (now seemingly unused after switching to Mermaid). |
Comments suppressed due to low confidence (2)
docs/content/en/docs/documentation/eventing.md:238
- There’s a typo in the field name:
.metada.generationshould be.metadata.generation. Also, the sentence starting with...triggered if either managed resources are changed...would read more clearly as...if either the managed resources change...(or similar).
managed resources are changed or the primary resource `.spec` field is changed. If other fields
like `.metadata` are changed on the primary resource, the reconciliation could be skipped. This
behavior is supported out of the box and reconciliation is by default not triggered if
changes to the primary resource do not increase the `.metadata.generation` field.
Note that changes to `.metada.generation` are automatically handled by Kubernetes.
docs/content/en/docs/documentation/eventing.md:18
- Grammar issue:
Event sources act as listen to events...is ungrammatical and reads like a typo (likely intendedact as listenersoract by listening). Since this paragraph is being edited, it would be good to fix this wording for clarity.
`Reconciler` will only listen by default to events affecting the primary resource type it is
configured for. Event sources act as listen to events affecting these secondary resources so
that a reconciliation of the associated primary resource can be triggered when needed. Note that
Comment on lines
15
to
+16
| public class DeploymentReconciler | ||
| implements Reconciler<Deployment>, TestExecutionInfoProvider { | ||
| implements Reconciler<Deployment> { |
There was a problem hiding this comment.
This PR is titled/described as improving the eventing docs image/wording, but this hunk also changes the example in features.md (removing TestExecutionInfoProvider). If this is intentional, consider briefly mentioning it in the PR description (or splitting into a separate docs PR) to keep review scope clear.
metacosm
requested changes
Apr 20, 2026
xstefank
approved these changes
Apr 21, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 3 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (2)
docs/content/en/docs/documentation/eventing.md:18
- The sentence “Event sources act as listen to events…” is ungrammatical and reads like a typo. Consider rephrasing to something like “Event sources act as listeners for events…” to improve clarity.
`Reconciler` will only listen by default to events affecting the primary resource type it is
configured for. Event sources act as listen to events affecting these secondary resources so
that a reconciliation of the associated primary resource can be triggered when needed. Note that
docs/content/en/docs/documentation/eventing.md:238
- Typo in the inline code:
.metada.generationshould be.metadata.generation.
managed resources are changed or the primary resource `.spec` field is changed. If other fields
like `.metadata` are changed on the primary resource, the reconciliation could be skipped. This
behavior is supported out of the box and reconciliation is by default not triggered if
changes to the primary resource do not increase the `.metadata.generation` field.
Note that changes to `.metada.generation` are automatically handled by Kubernetes.
The dependent resource might be confusing here, since we don't mean the feature but rather resource that we manage Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
csviri
force-pushed
the
docs-impr-reconcile
branch
from
8ba022b to
77672cd
Compare
metacosm
approved these changes
Apr 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The dependent resource might be confusing here, since we don't mean the feature but rather secondary resources.
Signed-off-by: Attila Mészáros a_meszaros@apple.com